Type Definitions

The following type definitions are available globally.

  • A block type which provides both the old and new versions of an object in the Realm. Object properties can only be accessed using keyed subscripting.

    See

    -[RLMMigration enumerateObjects:block:]

    Declaration

    Objective‑C

    typedef void (^RLMObjectMigrationBlock)(RLMObject *_Nullable,
                                        RLMObject *_Nullable)

    Swift

    typealias RLMObjectMigrationBlock = (RLMObject?, RLMObject?) -> Void

    Parameters

    oldObject

    The object from the original Realm (read-only).
    newObject

    The object from the migrated Realm (read-write).
    Show on GitHub

  • The type of a block to run whenever the data within the Realm is modified.

    See

    -[RLMRealm addNotificationBlock:]

    Declaration

    Objective‑C

    typedef void (^RLMNotificationBlock)(NSString *_Nonnull, RLMRealm *_Nonnull)

    Swift

    typealias RLMNotificationBlock = (String, RLMRealm) -> Void
    Show on GitHub

  • The type of a migration block used to migrate a Realm.

    Declaration

    Objective‑C

    typedef void (^RLMMigrationBlock)(RLMMigration *_Nonnull, uint64_t)

    Swift

    typealias RLMMigrationBlock = (RLMMigration, UInt64) -> Void

    Parameters

    migration

    A RLMMigration object used to perform the migration. The migration object allows you to enumerate and alter any existing objects which require migration.
    oldSchemaVersion

    The schema version of the Realm being migrated.
    Show on GitHub